Add backticks to diff messages for trait changes #2075
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Tests fail since I used System.lineSeparator() instead of "\n", but the testcases use "\n". Should I change my code to use "\n" or change the testcases to check for System.lineSeparator()? |
mtdowling
requested changes
Dec 18, 2023
There was a problem hiding this comment.
For the failing tests, we usually fix the test cases to normalize line endings when we run into these issues. We want to use the right line separator when we write output, but assertions need to be normalized (e.g., find and replace "\r\n" with "\n" on the input and output when doing the assertions).
smithy-model/src/main/java/software/amazon/smithy/model/node/Node.java
Outdated
Show resolved
Hide resolved
smithy-diff/src/main/java/software/amazon/smithy/diff/evaluators/TraitBreakingChange.java
Outdated
Show resolved
Hide resolved
smithy-diff/src/main/java/software/amazon/smithy/diff/evaluators/ModifiedTrait.java
Outdated
Show resolved
Hide resolved
rchache
force-pushed
the
backtickImprovement
branch
from
463cffe to
8cf5028
Compare
rchache
force-pushed
the
backtickImprovement
branch
from
8cf5028 to
c20cbf7
Compare
mtdowling
approved these changes
Jan 24, 2024
hpmellema
pushed a commit
to hpmellema/smithy
that referenced
this pull request
Jan 25, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of changes:
Adds backticks (or triple backticks) around trait values within diff event messages. This better supports markdown rendering of the messages.
Also changes pretty-printing to use platform-specific line separator through "%n"
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.